Upgrade or Downgrade Service License

This request enables you to do one of the following:

■

Upgrade the license type from Direct Routing Essential Plus to Direct Routing Pro.

■

Downgrade the license type from Direct Routing Pro to Direct Routing EssentialsPlus

■

Upgrade the license type from OC EssentialPlus to OC Pro.

■

Downgrade the license type from OC Pro to OC EssentialsPlus.

The upgrade requires you to enter the credentials of the Application Registration for securing connection to the customer tenant M365 platform. For creating the Application Registration for Direct Routing services, see Run Invitation wizard using Application Registration and for Operator Connect services, see Upgrading to OC Essentials Plus or OC Pro.

URI

Copy

{{baseUrl}}/api/v3/customer/{umpCustomerGuid}

HTTP Method

PATCH

Request Parameters

Parameter	Type	Description
CustomerGuid	string($uuid)	This id is created in the Live Platform database for the customer tenant when a Live Platform license is applied. If this field is null, a license has not yet been applied to the lead. This value is also obtained in the 'Get Task' response when the customer is created.

Request Body

Parameter

Type

Description

upgradeToLicense

integer

One of the following values:

■

1: Hosted Essentials Plus

■

2: Hosted Pro

■

4: OC Essential Plus

■

5: OC Pro

licenseCount

integer

The number of licensed users to configure for the customer service.

applicationClientId

string

The Application (Client) Id of the Application Registration for M365 tenant connection. Extract this value from app registration on customer tenant Azure portal.

applicationClientSecret

string

The client secret of the Application Registration for the M365 tenant connection. Extract this value from app registration on customer tenant Azure portal.

Example Request Body

Copy

{
  "customerFullName": "BBOC532",
  "licenseType": 5,
  "licensedUsersCount": 50,
  "applicationClientId": "0fdc8122-e0b5-43ac-8433-54860113710d",
  "applicationClientSecret": "pr18Q~Fk0bpCZdK7dd4jZvZRy8mXeonQPLasEblW"
}

Example Response

Copy

HTTP Responses

■

200 OK

■

400 Bad Request: When the 'upgradetoLicense' parameter is configured with an invalid value:

Copy

{
  "licenseType": 7
}

The following error is displayed:

Copy

"Invalid change for License Type!"

See 'upgradeToLicense' parameters shown above for valid types.